<!DOCTYPE html>
<html lang="en-US">
    <head>
        <title>IO::Uncompress::UnLzip - Read lzip files/buffers - metacpan.org</title>
        <link rel="preload" as="fetch" href="https://metacpan.org/account/login_status" crossorigin="anonymous" />
        <link href="https://metacpan.org/_assets/b8ccceeed47a0652049703d99326a9cea4933443.css" rel="stylesheet" type="text/css">
        <script src="https://metacpan.org/_assets/6bfedafe2d7caa915b7d84f61b45936818e3242e.js" type="text/javascript" defer></script>
        <link rel="alternate" type="application/rss+xml" title="Recent CPAN Uploads of IO-Compress-Lzma - MetaCPAN" href="https://metacpan.org/dist/IO-Compress-Lzma/releases.rss" />
        <link rel="canonical" href="./IO::Uncompress::UnLzip.html" />
        <meta name="description" content="Read lzip files/buffers" />
        <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=5">
        <link rel="shortcut icon" href="https://metacpan.org/static/icons/favicon.ico">
        <link rel="apple-touch-icon" sizes="152x152" href="https://metacpan.org/static/icons/apple-touch-icon.png">
        <link rel="search" href="https://metacpan.org/static/opensearch.xml" type="application/opensearchdescription+xml" title="MetaCPAN">
        <script>
          (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
          (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
          m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
          })(window,document,'script','//www.google-analytics.com/analytics.js','ga');

          (function(skey, ga_id){
            ga('create', ga_id, {
              siteSpeedSampleRate : 100,
              storage             : 'none',
              clientId            : localStorage.getItem(skey)
            });
            ga(function(tracker) {
              localStorage.setItem(skey, tracker.get('clientId'));
            });
            ga('send', 'pageview');
          })('ga:clientId', 'UA-27829474-1');
        </script>
<meta name="twitter:card"        content="summary" />
<meta name="twitter:url"         content="https://metacpan.org/pod/IO::Uncompress::UnLzip" />
<meta name="twitter:title"       content="IO::Uncompress::UnLzip" />
<meta name="twitter:description" content="Read lzip files/buffers" />
<meta name="twitter:site"        content="metacpan" />
    </head>
    <body>
        <nav class="navbar navbar-default" role="navigation">
            <div class="header-logo-large hidden-xs">
              <a href="https://metacpan.org/" tabindex="0">
                <svg class="logo" aria-label="MetaCPAN">
                  <use class="logo" href="/static/images/metacpan-logo.svg#logo" />
                </svg>
              </a>
            </div>
            <div class="header-logo-icon visible-xs">
              <a href="https://metacpan.org/">
                <svg class="logo" aria-label="MetaCPAN">
                  <use class="logo" href="/static/images/metacpan-logo.svg#dots" />
                </svg>
              </a>
            </div>
            <ul class="nav navbar-nav menu-items hidden-xs hidden-sm">
              <li><a href="https://metacpan.org/about">About</a></li>
              <li><a href="https://metacpan.org/about/sponsors">Sponsor</a></li>
              <li><a href="https://grep.metacpan.org/">grep::cpan</a></li>
              <li><a href="https://metacpan.org/recent">Recent</a></li>
              <li><a href="https://metacpan.org/about/faq">FAQ</a></li>
              <li><a href="https://metacpan.org/tools">Tools</a></li>
              <li><a href="https://fastapi.metacpan.org/">API</a></li>
            </ul>
            <ul class="nav navbar-nav navbar-right">
                <button type="button" class="searchbar-btn visible-xs visible-sm">
                    <i class="fa fa-search button-fa-icon"></i>
                </button>
                <form action="https://metacpan.org/search" class="searchbar-form visible-md visible-lg search-form form-horizontal">
                   <input type="hidden" name="size" id="metacpan_search-size" value="20">
                  <div class="form-group">
                      <div class="search-group">
                        <i class="fa fa-search"></i>
                        <input type="text" name="q" placeholder="Search the CPAN" size="41" autocorrect="off" autocapitalize="off" spellcheck="false" id="metacpan_search-input" class="form-control" value="">
                      </div>
                  </div>
                </form>
                    <li class="icon-slidepanel visible-xs visible-sm">
                      <button data-toggle="slidepanel" data-target=".slidepanel">
                        <span class="button-fa-icon">
                          <i class="fa fa-bars slidepanel-open"></i>
                          <i class="fa fa-times slidepanel-close"></i>
                        </span>
                      </button>
                    </li>
                <form action="https://metacpan.org/account/logout" method="POST" id="metacpan-logout"></form>
                <li class="dropdown logged_in" style="display: none;">
                    <button type="button" class="dropdown-toggle" data-toggle="dropdown">
                      <i class="fa fa-user button-fa-icon logged-in-icon" aria-hidden="true"></i>
                      <i class="fas fa-chevron-down"></i>
                    </button>
                    <ul class="dropdown-menu">
                        <li><a href="https://metacpan.org/account/identities">Identities</a></li>
                        <li><a href="https://metacpan.org/account/profile">Profile</a></li>
                        <li><a href="https://metacpan.org/account/favorite/list">Favorites</a></li>
                        <li>
                            <a href="./IO::Uncompress::UnLzip.html#" type="button" onclick="$('#metacpan-logout').submit(); return false">
                              Logout
                            </a>
                        </li>
                    </ul>
                </li>
                <li class="dropdown logged_out" style="display: none;">
                    <button type="button" class="dropdown-toggle" data-toggle="dropdown">
                      <i class="fa fa-user button-fa-icon" aria-hidden="true"></i>
                      <i class="fas fa-chevron-down"></i>
                    </button>
                    <ul class="dropdown-menu">
                        <li>
                            <a href="https://metacpan.org/login/github">
                                <i class="fab fa-github fa-fw"></i>
                                GitHub
                            </a>
                        </li>
                        <li>
                            <a href="https://metacpan.org/login/twitter">
                                <i class="fab fa-twitter fa-fw"></i>
                                Twitter
                            </a>
                        </li>
                        <li>
                            <a href="https://metacpan.org/login/google">
                                <i class="fab fa-google fa-fw"></i>
                                Google
                            </a>
                        </li>
                    </ul>
                </li>
                <li class="dropdown logged_placeholder">
                    <button>
                      <i class="fa fa-user button-fa-icon" aria-hidden="true"></i>
                    </button>
                </li>
            </ul>
        </nav>
        <div class="page-content ">
          <!--
          <div class="top-notify-banner">
            <i class="fas fa-info-circle"></i>
          </div>
          -->
          <nav class="sidebar">
            <div class="slidepanel">
              <ul class="nav-list ">
    <li class="nav-header no-margin-top">
      <div class="ttip" data-toggle="tooltip" data-placement="bottom" title="The date that this version of IO-Compress-Lzma was released.">
      <span class="relatize">25 Jul 2023 16:00:17 UTC</span>
    </li>
  <li>
    Distribution: <a href="https://metacpan.org/dist/IO-Compress-Lzma">IO-Compress-Lzma</a>
  </li>
  <li>
    Module version: 2.206
  </li>
  <li>
    <a data-keyboard-shortcut="g s" href="https://metacpan.org/dist/IO-Compress-Lzma/source/lib/IO/Uncompress/UnLzip.pm">Source</a>
    (<a href="https://metacpan.org/dist/IO-Compress-Lzma/source/lib/IO/Uncompress/UnLzip.pm?raw=1">raw</a>)
  </li>
  <li>
    <a data-keyboard-shortcut="g b" href="https://metacpan.org/dist/IO-Compress-Lzma/source/lib/IO/Uncompress">Browse</a>
    (<a href="https://metacpan.org/dist/IO-Compress-Lzma/source/lib/IO/Uncompress?raw=1">raw</a>)
  </li>
    <li>
      <a data-keyboard-shortcut="g c" href="https://metacpan.org/dist/IO-Compress-Lzma/changes">Changes</a>
    </li>
    <li>
      <a rel="noopener nofollow" class="nopopup" href="https://github.com/pmqs/IO-Compress-Lzma">Homepage</a>
    </li>
    <li>
      <a class="nopopup" href="https://metacpan.org/dist/IO-Compress-Lzma/contribute">How to Contribute</a>
    </li>
    <li>
        <a rel="noopener nofollow" data-keyboard-shortcut="g r" href="https://github.com/pmqs/IO-Compress-Lzma">Repository</a>
    </li>
    <li>
      <a rel="noopener nofollow" data-keyboard-shortcut="g i" href="https://github.com/pmqs/IO-Compress-Lzma/issues">Issues</a>
      (1)
    </li>
    <li>
      <a rel="noopener nofollow" href="http://matrix.cpantesters.org/?dist=IO-Compress-Lzma+2.206" title="Matrix">Testers</a>
        <span title="(pass / fail / na)">(<a rel="noopener nofollow" href="https://www.cpantesters.org/distro/I/IO-Compress-Lzma.html?oncpan=1&amp;distmat=1&amp;version=2.206&amp;grade=2" style="color: #090">568</a> / <a rel="noopener nofollow" href="https://www.cpantesters.org/distro/I/IO-Compress-Lzma.html?oncpan=1&amp;distmat=1&amp;version=2.206&amp;grade=3" style="color: #900">6</a> / <a rel="noopener nofollow" href="https://www.cpantesters.org/distro/I/IO-Compress-Lzma.html?oncpan=1&amp;distmat=1&amp;version=2.206&amp;grade=4">0</a>)</span>
    </li>
    <li>
      <a rel="noopener nofollow" href="http://cpants.cpanauthors.org/release/PMQS/IO-Compress-Lzma-2.206">Kwalitee</a>
    </li>
    <li>
      <div class="ttip" data-toggle="tooltip" data-placement="bottom" title="The # people with an indexing permission on IO-Compress-Lzma who have released something to CPAN in the last 2 years (i.e. the # people likely able to release critical fixes in a timely manner)">
      Bus factor: 1
      </div>
    </li>
    <li>
      <a rel="noopener nofollow" href="http://cpancover.com/latest/IO-Compress-Lzma-2.206/index.html">% Coverage </a>
    </li>
    <li>
      License: perl_5
    </li>
    <li class="nav-header">Activity</li>
    <li>
<div class="activity-graph">
    <img src="https://metacpan.org/dist/IO-Compress-Lzma/activity.svg?res=month" />
    <div class="comment">24 month</div>
</div>
    </li>
    <li class="nav-header">Tools</li>
    <li>
      <a itemprop="downloadUrl" href="https://cpan.metacpan.org/authors/id/P/PM/PMQS/IO-Compress-Lzma-2.206.tar.gz">
      Download (<span itemprop="fileSize">102.14KB</span>)</a>
    </li>
    <li>
      <a href="https://explorer.metacpan.org/?url=%2Fmodule%2FPMQS%2FIO-Compress-Lzma-2.206%2Flib%2FIO%2FUncompress%2FUnLzip.pm">
        MetaCPAN Explorer
      </a>
    </li>
    <li>
      <a href="https://metacpan.org/dist/IO-Compress-Lzma/permissions">
        Permissions
      </a>
    </li>
    <li>
      <a href="https://metacpan.org/dist/IO-Compress-Lzma/releases.rss">
        Subscribe to distribution
      </a>
    </li>
    <li>
      <button class="btn btn-link" data-toggle="modal" data-target="#metacpan_install-instructions-dialog">
        Install Instructions
      </button>
    </li>
    <li>
      <form action="https://metacpan.org/search">
        <input type="hidden" name="q" value="dist:IO-Compress-Lzma">
        <input type="search" name="q" placeholder="Search distribution" class="form-control tool-bar-form">
        <input type="submit" style="display: none">
      </form>
    </li>
    <li>
      <form action="https://grep.metacpan.org/search">
        <input type="hidden" name="qd" value="IO-Compress-Lzma">
        <input type="hidden" name="source" value="metacpan">
        <input type="search" name="q" placeholder="grep distribution" class="form-control tool-bar-form">
        <input type="submit" style="display: none">
     </form>
    </li>
    <li class="version-jump">
<select onchange="document.location.href=&#39;/release/&#39;+this.value+&#39;/view/lib/IO/Uncompress/UnLzip.pm&#39;" class="form-control tool-bar-form">
  <option disabled selected>Jump to version</option>
<option
  disabled
  value="PMQS/IO-Compress-Lzma-2.206"
>2.206
  (PMQS on 2023-07-25)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.205"
>2.205
  (PMQS on 2023-07-16)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.204"
>2.204
  (PMQS on 2023-02-08)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.201"
>2.201
  (PMQS on 2022-06-25)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.103"
>2.103
  (PMQS on 2022-04-03)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.101"
>2.101
  (PMQS on 2021-02-20)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.100"
>2.100
  (PMQS on 2021-01-07)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.096"
>2.096
  (PMQS on 2020-07-31)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.095"
>2.095
  (PMQS on 2020-07-20)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.094"
>2.094
  (PMQS on 2020-07-14)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.093"
>2.093
  (PMQS on 2019-12-07)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.092"
>2.092
  (PMQS on 2019-12-04)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.091"
>2.091
  (PMQS on 2019-11-23)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.090"
>2.090
  (PMQS on 2019-11-09)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.089"
>2.089
  (PMQS on 2019-11-03)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.088"
>2.088
  (PMQS on 2019-11-03)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.087"
>2.087
  (PMQS on 2019-08-10)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.086"
>2.086
  (PMQS on 2019-03-31)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.084"
>2.084
  (PMQS on 2019-01-06)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.083"
>2.083
  (PMQS on 2018-12-30)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.081"
>2.081
  (PMQS on 2018-04-08)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.080"
>2.080
  (PMQS on 2018-04-03)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.074"
>2.074
  (PMQS on 2017-02-19)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.072"
>2.072
  (PMQS on 2017-02-12)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.070"
>2.070
  (PMQS on 2016-12-28)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.069"
>2.069
  (PMQS on 2015-09-26)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.068"
>2.068
  (PMQS on 2014-12-23)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.067"
>2.067
  (PMQS on 2014-12-08)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.066"
>2.066
  (PMQS on 2014-09-21)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.064"
>2.064
  (PMQS on 2014-02-01)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.063"
>2.063
  (PMQS on 2013-11-02)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.062"
>2.062
  (PMQS on 2013-08-12)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.061"
>2.061
  (PMQS on 2013-05-27)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.060"
>2.060
  (PMQS on 2013-01-07)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.059"
>2.059
  (PMQS on 2012-12-15)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.058"
>2.058
  (PMQS on 2012-11-12)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.057"
>2.057
  (PMQS on 2012-11-10)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.055"
>2.055
  (PMQS on 2012-08-05)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.052"
>2.052
  (PMQS on 2012-04-29)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.049"
>2.049
  (PMQS on 2012-02-18)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.048"
>2.048
  (PMQS on 2012-01-29)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.047"
>2.047
  (PMQS on 2012-01-28)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.045"
>2.045
  (PMQS on 2011-12-04)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.044"
>2.044
  (PMQS on 2011-12-03)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.043"
>2.043
  (PMQS on 2011-11-20)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.042"
>2.042
  (PMQS on 2011-11-17)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.041"
>2.041
  (PMQS on 2011-10-29)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.040"
>2.040
  (PMQS on 2011-10-28)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.039"
>2.039
  (PMQS on 2011-10-28)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.038"
>2.038
  (PMQS on 2011-06-23)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.037"
>2.037
  (PMQS on 2011-06-22)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.036"
>2.036
  (PMQS on 2011-06-18)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.035"
>2.035
  (PMQS on 2011-05-07)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.034"
>2.034
  (PMQS on 2011-05-02)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.033"
>2.033
  (PMQS on 2011-01-11)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.032"
>2.032
  (PMQS on 2011-01-06)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.030"
>2.030
  (PMQS on 2010-07-24)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.027"
>2.027
  (PMQS on 2010-04-24)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.026"
>2.026
  (PMQS on 2010-04-07)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.025"
>2.025
  (PMQS on 2010-03-28)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.024"
>2.024
  (PMQS on 2010-01-09)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.023"
>2.023
  (PMQS on 2009-11-09)</option>
<optgroup label="BackPAN">'
<option
  
  value="PMQS/IO-Compress-Lzma-2.073"
>2.073
  (PMQS on 2017-02-19)</option>
</optgroup>
</select>
    </li>
    <li class="version-diff">
<select onchange="document.location.href='/release/PMQS/IO-Compress-Lzma-2.206/diff/' + encodeURIComponent(this.value) + '/lib/IO/Uncompress/UnLzip.pm'
" class="form-control tool-bar-form">
  <option disabled selected>Diff with version</option>
<option
  disabled
  value="PMQS/IO-Compress-Lzma-2.206"
>2.206
  (PMQS on 2023-07-25)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.205"
>2.205
  (PMQS on 2023-07-16)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.204"
>2.204
  (PMQS on 2023-02-08)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.201"
>2.201
  (PMQS on 2022-06-25)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.103"
>2.103
  (PMQS on 2022-04-03)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.101"
>2.101
  (PMQS on 2021-02-20)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.100"
>2.100
  (PMQS on 2021-01-07)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.096"
>2.096
  (PMQS on 2020-07-31)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.095"
>2.095
  (PMQS on 2020-07-20)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.094"
>2.094
  (PMQS on 2020-07-14)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.093"
>2.093
  (PMQS on 2019-12-07)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.092"
>2.092
  (PMQS on 2019-12-04)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.091"
>2.091
  (PMQS on 2019-11-23)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.090"
>2.090
  (PMQS on 2019-11-09)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.089"
>2.089
  (PMQS on 2019-11-03)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.088"
>2.088
  (PMQS on 2019-11-03)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.087"
>2.087
  (PMQS on 2019-08-10)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.086"
>2.086
  (PMQS on 2019-03-31)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.084"
>2.084
  (PMQS on 2019-01-06)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.083"
>2.083
  (PMQS on 2018-12-30)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.081"
>2.081
  (PMQS on 2018-04-08)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.080"
>2.080
  (PMQS on 2018-04-03)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.074"
>2.074
  (PMQS on 2017-02-19)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.072"
>2.072
  (PMQS on 2017-02-12)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.070"
>2.070
  (PMQS on 2016-12-28)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.069"
>2.069
  (PMQS on 2015-09-26)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.068"
>2.068
  (PMQS on 2014-12-23)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.067"
>2.067
  (PMQS on 2014-12-08)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.066"
>2.066
  (PMQS on 2014-09-21)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.064"
>2.064
  (PMQS on 2014-02-01)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.063"
>2.063
  (PMQS on 2013-11-02)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.062"
>2.062
  (PMQS on 2013-08-12)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.061"
>2.061
  (PMQS on 2013-05-27)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.060"
>2.060
  (PMQS on 2013-01-07)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.059"
>2.059
  (PMQS on 2012-12-15)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.058"
>2.058
  (PMQS on 2012-11-12)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.057"
>2.057
  (PMQS on 2012-11-10)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.055"
>2.055
  (PMQS on 2012-08-05)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.052"
>2.052
  (PMQS on 2012-04-29)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.049"
>2.049
  (PMQS on 2012-02-18)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.048"
>2.048
  (PMQS on 2012-01-29)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.047"
>2.047
  (PMQS on 2012-01-28)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.045"
>2.045
  (PMQS on 2011-12-04)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.044"
>2.044
  (PMQS on 2011-12-03)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.043"
>2.043
  (PMQS on 2011-11-20)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.042"
>2.042
  (PMQS on 2011-11-17)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.041"
>2.041
  (PMQS on 2011-10-29)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.040"
>2.040
  (PMQS on 2011-10-28)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.039"
>2.039
  (PMQS on 2011-10-28)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.038"
>2.038
  (PMQS on 2011-06-23)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.037"
>2.037
  (PMQS on 2011-06-22)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.036"
>2.036
  (PMQS on 2011-06-18)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.035"
>2.035
  (PMQS on 2011-05-07)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.034"
>2.034
  (PMQS on 2011-05-02)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.033"
>2.033
  (PMQS on 2011-01-11)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.032"
>2.032
  (PMQS on 2011-01-06)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.030"
>2.030
  (PMQS on 2010-07-24)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.027"
>2.027
  (PMQS on 2010-04-24)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.026"
>2.026
  (PMQS on 2010-04-07)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.025"
>2.025
  (PMQS on 2010-03-28)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.024"
>2.024
  (PMQS on 2010-01-09)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.023"
>2.023
  (PMQS on 2009-11-09)</option>
<optgroup label="BackPAN">'
<option
  
  value="PMQS/IO-Compress-Lzma-2.073"
>2.073
  (PMQS on 2017-02-19)</option>
</optgroup>
</select>
    </li>

    <li>
<ul class="dependencies">
  <li class="nav-header">Dependencies</li>
  <li><a href="https://metacpan.org/pod/Compress::Raw::Lzma" title="Compress::Raw::Lzma" class="ellipsis">Compress::Raw::Lzma</a></li>
  <li><a href="https://metacpan.org/pod/IO::Compress::Base" title="IO::Compress::Base" class="ellipsis">IO::Compress::Base</a></li>
  <li><a href="https://metacpan.org/pod/IO::Uncompress::Base" title="IO::Uncompress::Base" class="ellipsis">IO::Uncompress::Base</a></li>
  <li><i class="ttip" title="dynamic_config enabled">and possibly others</i></li>
  <li>
    <hr>
  </li>
  <li>
    <a href="https://metacpan.org/module/IO::Uncompress::UnLzip/requires">Reverse dependencies</a>
  </li>
  <li>
    <a href="http://deps.cpantesters.org/?module=IO%3A%3AUncompress%3A%3AUnLzip">CPAN Testers List</a>
  </li>
  <li>
    <a href="https://cpandeps.grinnz.com/?dist=IO-Compress-Lzma">Dependency graph</a>
  </li>
</ul>
    </li>
    <li class="nav-header">Permalinks</li>
    <li>
      <a href="https://metacpan.org/release/PMQS/IO-Compress-Lzma-2.206/view/lib/IO/Uncompress/UnLzip.pm">This version</a>
    </li>
    <li>
      <a href="./IO::Uncompress::UnLzip.html">Latest version</a>
    </li>
    <li>
<div class="plussers">
<div class="nav-header">++ed by:</div>
<div>
    1 non-PAUSE user
</div>
</div>
    </li>
    <li>
    </li>
              </ul>
            </div>
          </nav>
          <div class="content-navigation">
<div class="breadcrumbs">
  <span>
    <a data-keyboard-shortcut="g a" rel="author" href="https://metacpan.org/author/PMQS" class="author-name">Paul Marquess</a>
  </span>
  <span>&nbsp;/&nbsp;</span>
  <div class="release dist-release status-latest maturity-released">
    <span class="dropdown"><b class="caret"></b></span>
<select onchange="document.location.href=&#39;/release/&#39;+this.value+&#39;/view/lib/IO/Uncompress/UnLzip.pm&#39;" class="">
<option
  selected
  value="PMQS/IO-Compress-Lzma-2.206"
>2.206
  (PMQS on 2023-07-25)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.205"
>2.205
  (PMQS on 2023-07-16)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.204"
>2.204
  (PMQS on 2023-02-08)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.201"
>2.201
  (PMQS on 2022-06-25)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.103"
>2.103
  (PMQS on 2022-04-03)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.101"
>2.101
  (PMQS on 2021-02-20)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.100"
>2.100
  (PMQS on 2021-01-07)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.096"
>2.096
  (PMQS on 2020-07-31)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.095"
>2.095
  (PMQS on 2020-07-20)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.094"
>2.094
  (PMQS on 2020-07-14)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.093"
>2.093
  (PMQS on 2019-12-07)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.092"
>2.092
  (PMQS on 2019-12-04)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.091"
>2.091
  (PMQS on 2019-11-23)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.090"
>2.090
  (PMQS on 2019-11-09)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.089"
>2.089
  (PMQS on 2019-11-03)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.088"
>2.088
  (PMQS on 2019-11-03)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.087"
>2.087
  (PMQS on 2019-08-10)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.086"
>2.086
  (PMQS on 2019-03-31)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.084"
>2.084
  (PMQS on 2019-01-06)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.083"
>2.083
  (PMQS on 2018-12-30)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.081"
>2.081
  (PMQS on 2018-04-08)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.080"
>2.080
  (PMQS on 2018-04-03)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.074"
>2.074
  (PMQS on 2017-02-19)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.072"
>2.072
  (PMQS on 2017-02-12)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.070"
>2.070
  (PMQS on 2016-12-28)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.069"
>2.069
  (PMQS on 2015-09-26)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.068"
>2.068
  (PMQS on 2014-12-23)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.067"
>2.067
  (PMQS on 2014-12-08)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.066"
>2.066
  (PMQS on 2014-09-21)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.064"
>2.064
  (PMQS on 2014-02-01)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.063"
>2.063
  (PMQS on 2013-11-02)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.062"
>2.062
  (PMQS on 2013-08-12)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.061"
>2.061
  (PMQS on 2013-05-27)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.060"
>2.060
  (PMQS on 2013-01-07)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.059"
>2.059
  (PMQS on 2012-12-15)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.058"
>2.058
  (PMQS on 2012-11-12)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.057"
>2.057
  (PMQS on 2012-11-10)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.055"
>2.055
  (PMQS on 2012-08-05)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.052"
>2.052
  (PMQS on 2012-04-29)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.049"
>2.049
  (PMQS on 2012-02-18)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.048"
>2.048
  (PMQS on 2012-01-29)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.047"
>2.047
  (PMQS on 2012-01-28)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.045"
>2.045
  (PMQS on 2011-12-04)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.044"
>2.044
  (PMQS on 2011-12-03)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.043"
>2.043
  (PMQS on 2011-11-20)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.042"
>2.042
  (PMQS on 2011-11-17)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.041"
>2.041
  (PMQS on 2011-10-29)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.040"
>2.040
  (PMQS on 2011-10-28)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.039"
>2.039
  (PMQS on 2011-10-28)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.038"
>2.038
  (PMQS on 2011-06-23)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.037"
>2.037
  (PMQS on 2011-06-22)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.036"
>2.036
  (PMQS on 2011-06-18)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.035"
>2.035
  (PMQS on 2011-05-07)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.034"
>2.034
  (PMQS on 2011-05-02)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.033"
>2.033
  (PMQS on 2011-01-11)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.032"
>2.032
  (PMQS on 2011-01-06)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.030"
>2.030
  (PMQS on 2010-07-24)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.027"
>2.027
  (PMQS on 2010-04-24)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.026"
>2.026
  (PMQS on 2010-04-07)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.025"
>2.025
  (PMQS on 2010-03-28)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.024"
>2.024
  (PMQS on 2010-01-09)</option>
<option
  
  value="PMQS/IO-Compress-Lzma-2.023"
>2.023
  (PMQS on 2009-11-09)</option>
<optgroup label="BackPAN">'
<option
  
  value="PMQS/IO-Compress-Lzma-2.073"
>2.073
  (PMQS on 2017-02-19)</option>
</optgroup>
</select>
    <a data-keyboard-shortcut="g d" class="release-name" href="https://metacpan.org/dist/IO-Compress-Lzma">IO-Compress-Lzma-2.206</a>
  </div>
<span class="river-gauge-gauge">
  <svg width="24px"
       height="15px"
       version="1.1"
       xmlns="http://www.w3.org/2000/svg"
       xmlns:xlink="http://www.w3.org/1999/xlink">

    <g>
      <title>        River stage one &#10;
          • 5 direct dependents &#10;          • 7 total dependents
      </title>

      <rect x="0"  y="0" width="4" height="15" fill="#7ea3f2" />
      <rect x="5"  y="0" width="4" height="15" fill="#e4e2e2" />
      <rect x="10"  y="0" width="4" height="15" fill="#e4e2e2" />
      <rect x="15"  y="0" width="4" height="15" fill="#e4e2e2" />
      <rect x="20"  y="0" width="4" height="15" fill="#e4e2e2" />
    </g>
  </svg>

</span>
<div id="IO-Compress-Lzma-fav" class="logged_in">
<form action="https://metacpan.org/account/favorite/add" style="display: inline" onsubmit="return favDistribution(this)">
    <input type="hidden" name="remove" value="0">
    <input type="hidden" name="release" value="IO-Compress-Lzma-2.206">
    <input type="hidden" name="author" value="PMQS">
    <input type="hidden" name="distribution" value="IO-Compress-Lzma">
    <button type="submit" class="favorite highlight"><span>1</span> ++</button>
</form>
</div>
<div class="logged_out">
<a href="./IO::Uncompress::UnLzip.html" onclick="alert('Please sign in to add favorites'); return false" class="favorite highlight">
<span>1</span> ++</a>
</div>
   / <span>IO::Uncompress::UnLzip</span>
</div>
          </div>
          <main class="content">


<nav class="toc">
  <div class="toc-header"><strong>Contents</strong></div>
<ul>
  <li><a href="./IO::Uncompress::UnLzip.html#NAME">NAME</a></li>
  <li><a href="./IO::Uncompress::UnLzip.html#SYNOPSIS">SYNOPSIS</a></li>
  <li><a href="./IO::Uncompress::UnLzip.html#DESCRIPTION">DESCRIPTION</a></li>
  <li><a href="./IO::Uncompress::UnLzip.html#Functional-Interface">Functional Interface</a>
    <ul>
      <li><a href="./IO::Uncompress::UnLzip.html#unlzip-$input_filename_or_reference-=%3E-$output_filename_or_reference-%5B,-OPTS%5D">unlzip $input_filename_or_reference =&gt; $output_filename_or_reference [, OPTS]</a>
        <ul>
          <li><a href="./IO::Uncompress::UnLzip.html#The-$input_filename_or_reference-parameter">The $input_filename_or_reference parameter</a></li>
          <li><a href="./IO::Uncompress::UnLzip.html#The-$output_filename_or_reference-parameter">The $output_filename_or_reference parameter</a></li>
        </ul>
      </li>
      <li><a href="./IO::Uncompress::UnLzip.html#Notes">Notes</a></li>
      <li><a href="./IO::Uncompress::UnLzip.html#Optional-Parameters">Optional Parameters</a></li>
      <li><a href="./IO::Uncompress::UnLzip.html#OneShot-Examples">OneShot Examples</a></li>
    </ul>
  </li>
  <li><a href="./IO::Uncompress::UnLzip.html#OO-Interface">OO Interface</a>
    <ul>
      <li><a href="./IO::Uncompress::UnLzip.html#Constructor">Constructor</a></li>
      <li><a href="./IO::Uncompress::UnLzip.html#Constructor-Options">Constructor Options</a></li>
    </ul>
  </li>
  <li><a href="./IO::Uncompress::UnLzip.html#Methods">Methods</a>
    <ul>
      <li><a href="./IO::Uncompress::UnLzip.html#read">read</a></li>
      <li><a href="./IO::Uncompress::UnLzip.html#read1">read</a></li>
      <li><a href="./IO::Uncompress::UnLzip.html#getline">getline</a></li>
      <li><a href="./IO::Uncompress::UnLzip.html#getc">getc</a></li>
      <li><a href="./IO::Uncompress::UnLzip.html#ungetc">ungetc</a></li>
      <li><a href="./IO::Uncompress::UnLzip.html#getHeaderInfo">getHeaderInfo</a></li>
      <li><a href="./IO::Uncompress::UnLzip.html#tell">tell</a></li>
      <li><a href="./IO::Uncompress::UnLzip.html#eof">eof</a></li>
      <li><a href="./IO::Uncompress::UnLzip.html#seek">seek</a></li>
      <li><a href="./IO::Uncompress::UnLzip.html#binmode">binmode</a></li>
      <li><a href="./IO::Uncompress::UnLzip.html#opened">opened</a></li>
      <li><a href="./IO::Uncompress::UnLzip.html#autoflush">autoflush</a></li>
      <li><a href="./IO::Uncompress::UnLzip.html#input_line_number">input_line_number</a></li>
      <li><a href="./IO::Uncompress::UnLzip.html#fileno">fileno</a></li>
      <li><a href="./IO::Uncompress::UnLzip.html#close">close</a></li>
      <li><a href="./IO::Uncompress::UnLzip.html#nextStream">nextStream</a></li>
      <li><a href="./IO::Uncompress::UnLzip.html#trailingData">trailingData</a></li>
    </ul>
  </li>
  <li><a href="./IO::Uncompress::UnLzip.html#Importing">Importing</a></li>
  <li><a href="./IO::Uncompress::UnLzip.html#EXAMPLES">EXAMPLES</a></li>
  <li><a href="./IO::Uncompress::UnLzip.html#SUPPORT">SUPPORT</a></li>
  <li><a href="./IO::Uncompress::UnLzip.html#SEE-ALSO">SEE ALSO</a></li>
  <li><a href="./IO::Uncompress::UnLzip.html#AUTHOR">AUTHOR</a></li>
  <li><a href="./IO::Uncompress::UnLzip.html#MODIFICATION-HISTORY">MODIFICATION HISTORY</a></li>
  <li><a href="./IO::Uncompress::UnLzip.html#COPYRIGHT-AND-LICENSE">COPYRIGHT AND LICENSE</a></li>
</ul></nav>
<div class="pod anchors">
<h1 id="NAME">NAME</h1>

<p>IO::Uncompress::UnLzip - Read lzip files/buffers</p>

<h1 id="SYNOPSIS">SYNOPSIS</h1>

<pre><code>    use IO::Uncompress::UnLzip qw(unlzip $UnLzipError) ;

    my $status = unlzip $input =&gt; $output [,OPTS]
        or die &quot;unlzip failed: $UnLzipError\n&quot;;

    my $z = IO::Uncompress::UnLzip-&gt;new( $input [OPTS] )
        or die &quot;unlzip failed: $UnLzipError\n&quot;;

    $status = $z-&gt;read($buffer)
    $status = $z-&gt;read($buffer, $length)
    $status = $z-&gt;read($buffer, $length, $offset)
    $line = $z-&gt;getline()
    $char = $z-&gt;getc()
    $char = $z-&gt;ungetc()
    $char = $z-&gt;opened()

    $data = $z-&gt;trailingData()
    $status = $z-&gt;nextStream()
    $data = $z-&gt;getHeaderInfo()
    $z-&gt;tell()
    $z-&gt;seek($position, $whence)
    $z-&gt;binmode()
    $z-&gt;fileno()
    $z-&gt;eof()
    $z-&gt;close()

    $UnLzipError ;

    # IO::File mode

    &lt;$z&gt;
    read($z, $buffer);
    read($z, $buffer, $length);
    read($z, $buffer, $length, $offset);
    tell($z)
    seek($z, $position, $whence)
    binmode($z)
    fileno($z)
    eof($z)
    close($z)</code></pre>

<h1 id="DESCRIPTION">DESCRIPTION</h1>

<p>This module provides a Perl interface that allows the reading of lzma files/buffers.</p>

<p>For writing lzip files/buffers, see the companion module IO::Compress::Lzip.</p>

<h1 id="Functional-Interface"><a id="Functional"></a>Functional Interface</h1>

<p>A top-level function, <code>unlzip</code>, is provided to carry out &quot;one-shot&quot; uncompression between buffers and/or files. For finer control over the uncompression process, see the <a href="./IO::Uncompress::UnLzip.html#OO-Interface">&quot;OO Interface&quot;</a> section.</p>

<pre><code>    use IO::Uncompress::UnLzip qw(unlzip $UnLzipError) ;

    unlzip $input_filename_or_reference =&gt; $output_filename_or_reference [,OPTS]
        or die &quot;unlzip failed: $UnLzipError\n&quot;;</code></pre>

<p>The functional interface needs Perl5.005 or better.</p>

<h2 id="unlzip-$input_filename_or_reference-=&gt;-$output_filename_or_reference-[,-OPTS]"><a id="unlzip"></a><a id="unlzip--input_filename_or_reference----output_filename_or_reference---OPTS"></a>unlzip $input_filename_or_reference =&gt; $output_filename_or_reference [, OPTS]</h2>

<p><code>unlzip</code> expects at least two parameters, <code>$input_filename_or_reference</code> and <code>$output_filename_or_reference</code> and zero or more optional parameters (see <a href="./IO::Uncompress::UnLzip.html#Optional-Parameters">&quot;Optional Parameters&quot;</a>)</p>

<h3 id="The-$input_filename_or_reference-parameter"><a id="The"></a><a id="The--input_filename_or_reference-parameter"></a>The <code>$input_filename_or_reference</code> parameter</h3>

<p>The parameter, <code>$input_filename_or_reference</code>, is used to define the source of the compressed data.</p>

<p>It can take one of the following forms:</p>

<dl>

<dt id="A-filename"><a id="A"></a>A filename</dt>
<dd>

<p>If the <code>$input_filename_or_reference</code> parameter is a simple scalar, it is assumed to be a filename. This file will be opened for reading and the input data will be read from it.</p>

</dd>
<dt id="A-filehandle"><a id="A1"></a>A filehandle</dt>
<dd>

<p>If the <code>$input_filename_or_reference</code> parameter is a filehandle, the input data will be read from it. The string &#39;-&#39; can be used as an alias for standard input.</p>

</dd>
<dt id="A-scalar-reference"><a id="A2"></a>A scalar reference</dt>
<dd>

<p>If <code>$input_filename_or_reference</code> is a scalar reference, the input data will be read from <code>$$input_filename_or_reference</code>.</p>

</dd>
<dt id="An-array-reference"><a id="An"></a>An array reference</dt>
<dd>

<p>If <code>$input_filename_or_reference</code> is an array reference, each element in the array must be a filename.</p>

<p>The input data will be read from each file in turn.</p>

<p>The complete array will be walked to ensure that it only contains valid filenames before any data is uncompressed.</p>

</dd>
<dt id="An-Input-FileGlob-string"><a id="An1"></a>An Input FileGlob string</dt>
<dd>

<p>If <code>$input_filename_or_reference</code> is a string that is delimited by the characters &quot;&lt;&quot; and &quot;&gt;&quot; <code>unlzip</code> will assume that it is an <i>input fileglob string</i>. The input is the list of files that match the fileglob.</p>

<p>See <a href="https://metacpan.org/pod/File::GlobMapper">File::GlobMapper</a> for more details.</p>

</dd>
</dl>

<p>If the <code>$input_filename_or_reference</code> parameter is any other type, <code>undef</code> will be returned.</p>

<h3 id="The-$output_filename_or_reference-parameter"><a id="The1"></a><a id="The--output_filename_or_reference-parameter"></a>The <code>$output_filename_or_reference</code> parameter</h3>

<p>The parameter <code>$output_filename_or_reference</code> is used to control the destination of the uncompressed data. This parameter can take one of these forms.</p>

<dl>

<dt id="A-filename1"><a id="A3"></a>A filename</dt>
<dd>

<p>If the <code>$output_filename_or_reference</code> parameter is a simple scalar, it is assumed to be a filename. This file will be opened for writing and the uncompressed data will be written to it.</p>

</dd>
<dt id="A-filehandle1"><a id="A4"></a>A filehandle</dt>
<dd>

<p>If the <code>$output_filename_or_reference</code> parameter is a filehandle, the uncompressed data will be written to it. The string &#39;-&#39; can be used as an alias for standard output.</p>

</dd>
<dt id="A-scalar-reference1"><a id="A5"></a>A scalar reference</dt>
<dd>

<p>If <code>$output_filename_or_reference</code> is a scalar reference, the uncompressed data will be stored in <code>$$output_filename_or_reference</code>.</p>

</dd>
<dt id="An-Array-Reference"><a id="An2"></a>An Array Reference</dt>
<dd>

<p>If <code>$output_filename_or_reference</code> is an array reference, the uncompressed data will be pushed onto the array.</p>

</dd>
<dt id="An-Output-FileGlob"><a id="An3"></a>An Output FileGlob</dt>
<dd>

<p>If <code>$output_filename_or_reference</code> is a string that is delimited by the characters &quot;&lt;&quot; and &quot;&gt;&quot; <code>unlzip</code> will assume that it is an <i>output fileglob string</i>. The output is the list of files that match the fileglob.</p>

<p>When <code>$output_filename_or_reference</code> is an fileglob string, <code>$input_filename_or_reference</code> must also be a fileglob string. Anything else is an error.</p>

<p>See <a href="https://metacpan.org/pod/File::GlobMapper">File::GlobMapper</a> for more details.</p>

</dd>
</dl>

<p>If the <code>$output_filename_or_reference</code> parameter is any other type, <code>undef</code> will be returned.</p>

<h2 id="Notes">Notes</h2>

<p>When <code>$input_filename_or_reference</code> maps to multiple compressed files/buffers and <code>$output_filename_or_reference</code> is a single file/buffer, after uncompression <code>$output_filename_or_reference</code> will contain a concatenation of all the uncompressed data from each of the input files/buffers.</p>

<h2 id="Optional-Parameters"><a id="Optional"></a>Optional Parameters</h2>

<p>The optional parameters for the one-shot function <code>unlzip</code> are (for the most part) identical to those used with the OO interface defined in the <a href="./IO::Uncompress::UnLzip.html#Constructor-Options">&quot;Constructor Options&quot;</a> section. The exceptions are listed below</p>

<dl>

<dt id="AutoClose-=&gt;-0|1"><a id="AutoClose"></a><a id="AutoClose---0-1"></a><code>AutoClose =&gt; 0|1</code></dt>
<dd>

<p>This option applies to any input or output data streams to <code>unlzip</code> that are filehandles.</p>

<p>If <code>AutoClose</code> is specified, and the value is true, it will result in all input and/or output filehandles being closed once <code>unlzip</code> has completed.</p>

<p>This parameter defaults to 0.</p>

</dd>
<dt id="BinModeOut-=&gt;-0|1"><a id="BinModeOut"></a><a id="BinModeOut---0-1"></a><code>BinModeOut =&gt; 0|1</code></dt>
<dd>

<p>This option is now a no-op. All files will be written in binmode.</p>

</dd>
<dt id="Append-=&gt;-0|1"><a id="Append"></a><a id="Append---0-1"></a><code>Append =&gt; 0|1</code></dt>
<dd>

<p>The behaviour of this option is dependent on the type of output data stream.</p>

<ul>

<li><p>A Buffer</p>

<p>If <code>Append</code> is enabled, all uncompressed data will be append to the end of the output buffer. Otherwise the output buffer will be cleared before any uncompressed data is written to it.</p>

</li>
<li><p>A Filename</p>

<p>If <code>Append</code> is enabled, the file will be opened in append mode. Otherwise the contents of the file, if any, will be truncated before any uncompressed data is written to it.</p>

</li>
<li><p>A Filehandle</p>

<p>If <code>Append</code> is enabled, the filehandle will be positioned to the end of the file via a call to <code>seek</code> before any uncompressed data is written to it. Otherwise the file pointer will not be moved.</p>

</li>
</ul>

<p>When <code>Append</code> is specified, and set to true, it will <i>append</i> all uncompressed data to the output data stream.</p>

<p>So when the output is a filehandle it will carry out a seek to the eof before writing any uncompressed data. If the output is a filename, it will be opened for appending. If the output is a buffer, all uncompressed data will be appended to the existing buffer.</p>

<p>Conversely when <code>Append</code> is not specified, or it is present and is set to false, it will operate as follows.</p>

<p>When the output is a filename, it will truncate the contents of the file before writing any uncompressed data. If the output is a filehandle its position will not be changed. If the output is a buffer, it will be wiped before any uncompressed data is output.</p>

<p>Defaults to 0.</p>

</dd>
<dt id="MultiStream-=&gt;-0|1"><a id="MultiStream"></a><a id="MultiStream---0-1"></a><code>MultiStream =&gt; 0|1</code></dt>
<dd>

<p>If the input file/buffer contains multiple compressed data streams, this option will uncompress the whole lot as a single data stream.</p>

<p>Defaults to 0.</p>

</dd>
<dt id="TrailingData-=&gt;-$scalar"><a id="TrailingData"></a><a id="TrailingData----scalar"></a><code>TrailingData =&gt; $scalar</code></dt>
<dd>

<p>Returns the data, if any, that is present immediately after the compressed data stream once uncompression is complete.</p>

<p>This option can be used when there is useful information immediately following the compressed data stream, and you don&#39;t know the length of the compressed data stream.</p>

<p>If the input is a buffer, <code>trailingData</code> will return everything from the end of the compressed data stream to the end of the buffer.</p>

<p>If the input is a filehandle, <code>trailingData</code> will return the data that is left in the filehandle input buffer once the end of the compressed data stream has been reached. You can then use the filehandle to read the rest of the input file.</p>

<p>Don&#39;t bother using <code>trailingData</code> if the input is a filename.</p>

<p>If you know the length of the compressed data stream before you start uncompressing, you can avoid having to use <code>trailingData</code> by setting the <code>InputLength</code> option.</p>

</dd>
</dl>

<h2 id="OneShot-Examples"><a id="OneShot"></a>OneShot Examples</h2>

<p>To read the contents of the file <code>file1.txt.xz</code> and write the uncompressed data to the file <code>file1.txt</code>.</p>

<pre><code>    use strict ;
    use warnings ;
    use IO::Uncompress::UnLzip qw(unlzip $UnLzipError) ;

    my $input = &quot;file1.txt.xz&quot;;
    my $output = &quot;file1.txt&quot;;
    unlzip $input =&gt; $output
        or die &quot;unlzip failed: $UnLzipError\n&quot;;</code></pre>

<p>To read from an existing Perl filehandle, <code>$input</code>, and write the uncompressed data to a buffer, <code>$buffer</code>.</p>

<pre><code>    use strict ;
    use warnings ;
    use IO::Uncompress::UnLzip qw(unlzip $UnLzipError) ;
    use IO::File ;

    my $input = IO::File-&gt;new( &quot;&lt;file1.txt.xz&quot; )
        or die &quot;Cannot open &#39;file1.txt.xz&#39;: $!\n&quot; ;
    my $buffer ;
    unlzip $input =&gt; \$buffer
        or die &quot;unlzip failed: $UnLzipError\n&quot;;</code></pre>

<p>To uncompress all files in the directory &quot;/my/home&quot; that match &quot;*.txt.xz&quot; and store the compressed data in the same directory</p>

<pre><code>    use strict ;
    use warnings ;
    use IO::Uncompress::UnLzip qw(unlzip $UnLzipError) ;

    unlzip &#39;&lt;/my/home/*.txt.xz&gt;&#39; =&gt; &#39;&lt;/my/home/#1.txt&gt;&#39;
        or die &quot;unlzip failed: $UnLzipError\n&quot;;</code></pre>

<p>and if you want to compress each file one at a time, this will do the trick</p>

<pre><code>    use strict ;
    use warnings ;
    use IO::Uncompress::UnLzip qw(unlzip $UnLzipError) ;

    for my $input ( glob &quot;/my/home/*.txt.xz&quot; )
    {
        my $output = $input;
        $output =~ s/.xz// ;
        unlzip $input =&gt; $output
            or die &quot;Error compressing &#39;$input&#39;: $UnLzipError\n&quot;;
    }</code></pre>

<h1 id="OO-Interface"><a id="OO"></a>OO Interface</h1>

<h2 id="Constructor">Constructor</h2>

<p>The format of the constructor for IO::Uncompress::UnLzip is shown below</p>

<pre><code>    my $z = IO::Uncompress::UnLzip-&gt;new( $input [OPTS] )
        or die &quot;IO::Uncompress::UnLzip failed: $UnLzipError\n&quot;;</code></pre>

<p>The constructor takes one mandatory parameter, <code>$input</code>, defined below, and zero or more <code>OPTS</code>, defined in <a href="./IO::Uncompress::UnLzip.html#Constructor-Options">&quot;Constructor Options&quot;</a>.</p>

<p>Returns an <code>IO::Uncompress::UnLzip</code> object on success and undef on failure. The variable <code>$UnLzipError</code> will contain an error message on failure.</p>

<p>If you are running Perl 5.005 or better the object, <code>$z</code>, returned from IO::Uncompress::UnLzip can be used exactly like an <a href="https://metacpan.org/pod/IO::File">IO::File</a> filehandle. This means that all normal input file operations can be carried out with <code>$z</code>. For example, to read a line from a compressed file/buffer you can use either of these forms</p>

<pre><code>    $line = $z-&gt;getline();
    $line = &lt;$z&gt;;</code></pre>

<p>Below is a simple exaple of using the OO interface to read the compressed file <code>myfile.xz</code> and write its contents to stdout.</p>

<pre><code>    my $filename = &quot;myfile.xz&quot;;
    my $z = IO::Uncompress::UnLzip-&gt;new($filename)
        or die &quot;IO::Uncompress::UnLzip failed: $UnLzipError\n&quot;;

    while (&lt;$z&gt;) {
        print $_;
    }
    $z-&gt;close();</code></pre>

<p>See <a href="./IO::Uncompress::UnLzip.html#EXAMPLES">&quot;EXAMPLES&quot;</a> for further examples</p>

<p>The mandatory parameter <code>$input</code> is used to determine the source of the compressed data. This parameter can take one of three forms.</p>

<dl>

<dt id="A-filename2"><a id="A6"></a>A filename</dt>
<dd>

<p>If the <code>$input</code> parameter is a scalar, it is assumed to be a filename. This file will be opened for reading and the compressed data will be read from it.</p>

</dd>
<dt id="A-filehandle2"><a id="A7"></a>A filehandle</dt>
<dd>

<p>If the <code>$input</code> parameter is a filehandle, the compressed data will be read from it. The string &#39;-&#39; can be used as an alias for standard input.</p>

</dd>
<dt id="A-scalar-reference2"><a id="A8"></a>A scalar reference</dt>
<dd>

<p>If <code>$input</code> is a scalar reference, the compressed data will be read from <code>$$input</code>.</p>

</dd>
</dl>

<h2 id="Constructor-Options"><a id="Constructor1"></a>Constructor Options</h2>

<p>The option names defined below are case insensitive and can be optionally prefixed by a &#39;-&#39;. So all of the following are valid</p>

<pre><code>    -AutoClose
    -autoclose
    AUTOCLOSE
    autoclose</code></pre>

<p>OPTS is a combination of the following options:</p>

<dl>

<dt id="AutoClose-=&gt;-0|11"><a id="AutoClose1"></a><a id="AutoClose---0-11"></a><code>AutoClose =&gt; 0|1</code></dt>
<dd>

<p>This option is only valid when the <code>$input</code> parameter is a filehandle. If specified, and the value is true, it will result in the file being closed once either the <code>close</code> method is called or the IO::Uncompress::UnLzip object is destroyed.</p>

<p>This parameter defaults to 0.</p>

</dd>
<dt id="MultiStream-=&gt;-0|11"><a id="MultiStream1"></a><a id="MultiStream---0-11"></a><code>MultiStream =&gt; 0|1</code></dt>
<dd>

<p>Allows multiple concatenated compressed streams to be treated as a single compressed stream. Decompression will stop once either the end of the file/buffer is reached, an error is encountered (premature eof, corrupt compressed data) or the end of a stream is not immediately followed by the start of another stream.</p>

<p>This parameter defaults to 0.</p>

</dd>
<dt id="Prime-=&gt;-$string"><a id="Prime"></a><a id="Prime----string"></a><code>Prime =&gt; $string</code></dt>
<dd>

<p>This option will uncompress the contents of <code>$string</code> before processing the input file/buffer.</p>

<p>This option can be useful when the compressed data is embedded in another file/data structure and it is not possible to work out where the compressed data begins without having to read the first few bytes. If this is the case, the uncompression can be <i>primed</i> with these bytes using this option.</p>

</dd>
<dt id="Transparent-=&gt;-0|1"><a id="Transparent"></a><a id="Transparent---0-1"></a><code>Transparent =&gt; 0|1</code></dt>
<dd>

<p>If this option is set and the input file/buffer is not compressed data, the module will allow reading of it anyway.</p>

<p>In addition, if the input file/buffer does contain compressed data and there is non-compressed data immediately following it, setting this option will make this module treat the whole file/buffer as a single data stream.</p>

<p>This option defaults to 1.</p>

</dd>
<dt id="BlockSize-=&gt;-$num"><a id="BlockSize"></a><a id="BlockSize----num"></a><code>BlockSize =&gt; $num</code></dt>
<dd>

<p>When reading the compressed input data, IO::Uncompress::UnLzip will read it in blocks of <code>$num</code> bytes.</p>

<p>This option defaults to 4096.</p>

</dd>
<dt id="InputLength-=&gt;-$size"><a id="InputLength"></a><a id="InputLength----size"></a><code>InputLength =&gt; $size</code></dt>
<dd>

<p>When present this option will limit the number of compressed bytes read from the input file/buffer to <code>$size</code>. This option can be used in the situation where there is useful data directly after the compressed data stream and you know beforehand the exact length of the compressed data stream.</p>

<p>This option is mostly used when reading from a filehandle, in which case the file pointer will be left pointing to the first byte directly after the compressed data stream.</p>

<p>This option defaults to off.</p>

</dd>
<dt id="Append-=&gt;-0|11"><a id="Append1"></a><a id="Append---0-11"></a><code>Append =&gt; 0|1</code></dt>
<dd>

<p>This option controls what the <code>read</code> method does with uncompressed data.</p>

<p>If set to 1, all uncompressed data will be appended to the output parameter of the <code>read</code> method.</p>

<p>If set to 0, the contents of the output parameter of the <code>read</code> method will be overwritten by the uncompressed data.</p>

<p>Defaults to 0.</p>

</dd>
<dt id="Strict-=&gt;-0|1"><a id="Strict"></a><a id="Strict---0-1"></a><code>Strict =&gt; 0|1</code></dt>
<dd>

<p>This option controls whether the extra checks defined below are used when carrying out the decompression. When Strict is on, the extra tests are carried out, when Strict is off they are not.</p>

<p>The default for this option is off.</p>

</dd>
</dl>

<h1 id="Methods">Methods</h1>

<h2 id="read">read</h2>

<p>Usage is</p>

<pre><code>    $status = $z-&gt;read($buffer)</code></pre>

<p>Reads a block of compressed data (the size of the compressed block is determined by the <code>Buffer</code> option in the constructor), uncompresses it and writes any uncompressed data into <code>$buffer</code>. If the <code>Append</code> parameter is set in the constructor, the uncompressed data will be appended to the <code>$buffer</code> parameter. Otherwise <code>$buffer</code> will be overwritten.</p>

<p>Returns the number of uncompressed bytes written to <code>$buffer</code>, zero if eof or a negative number on error.</p>

<h2 id="read1">read</h2>

<p>Usage is</p>

<pre><code>    $status = $z-&gt;read($buffer, $length)
    $status = $z-&gt;read($buffer, $length, $offset)

    $status = read($z, $buffer, $length)
    $status = read($z, $buffer, $length, $offset)</code></pre>

<p>Attempt to read <code>$length</code> bytes of uncompressed data into <code>$buffer</code>.</p>

<p>The main difference between this form of the <code>read</code> method and the previous one, is that this one will attempt to return <i>exactly</i> <code>$length</code> bytes. The only circumstances that this function will not is if end-of-file or an IO error is encountered.</p>

<p>Returns the number of uncompressed bytes written to <code>$buffer</code>, zero if eof or a negative number on error.</p>

<h2 id="getline">getline</h2>

<p>Usage is</p>

<pre><code>    $line = $z-&gt;getline()
    $line = &lt;$z&gt;</code></pre>

<p>Reads a single line.</p>

<p>This method fully supports the use of the variable <code>$/</code> (or <code>$INPUT_RECORD_SEPARATOR</code> or <code>$RS</code> when <code>English</code> is in use) to determine what constitutes an end of line. Paragraph mode, record mode and file slurp mode are all supported.</p>

<h2 id="getc">getc</h2>

<p>Usage is</p>

<pre><code>    $char = $z-&gt;getc()</code></pre>

<p>Read a single character.</p>

<h2 id="ungetc">ungetc</h2>

<p>Usage is</p>

<pre><code>    $char = $z-&gt;ungetc($string)</code></pre>

<h2 id="getHeaderInfo">getHeaderInfo</h2>

<p>Usage is</p>

<pre><code>    $hdr  = $z-&gt;getHeaderInfo();
    @hdrs = $z-&gt;getHeaderInfo();</code></pre>

<p>This method returns either a hash reference (in scalar context) or a list or hash references (in array context) that contains information about each of the header fields in the compressed data stream(s).</p>

<h2 id="tell">tell</h2>

<p>Usage is</p>

<pre><code>    $z-&gt;tell()
    tell $z</code></pre>

<p>Returns the uncompressed file offset.</p>

<h2 id="eof">eof</h2>

<p>Usage is</p>

<pre><code>    $z-&gt;eof();
    eof($z);</code></pre>

<p>Returns true if the end of the compressed input stream has been reached.</p>

<h2 id="seek">seek</h2>

<pre><code>    $z-&gt;seek($position, $whence);
    seek($z, $position, $whence);</code></pre>

<p>Provides a sub-set of the <code>seek</code> functionality, with the restriction that it is only legal to seek forward in the input file/buffer. It is a fatal error to attempt to seek backward.</p>

<p>Note that the implementation of <code>seek</code> in this module does not provide true random access to a compressed file/buffer. It works by uncompressing data from the current offset in the file/buffer until it reaches the uncompressed offset specified in the parameters to <code>seek</code>. For very small files this may be acceptable behaviour. For large files it may cause an unacceptable delay.</p>

<p>The <code>$whence</code> parameter takes one the usual values, namely SEEK_SET, SEEK_CUR or SEEK_END.</p>

<p>Returns 1 on success, 0 on failure.</p>

<h2 id="binmode">binmode</h2>

<p>Usage is</p>

<pre><code>    $z-&gt;binmode
    binmode $z ;</code></pre>

<p>This is a noop provided for completeness.</p>

<h2 id="opened">opened</h2>

<pre><code>    $z-&gt;opened()</code></pre>

<p>Returns true if the object currently refers to a opened file/buffer.</p>

<h2 id="autoflush">autoflush</h2>

<pre><code>    my $prev = $z-&gt;autoflush()
    my $prev = $z-&gt;autoflush(EXPR)</code></pre>

<p>If the <code>$z</code> object is associated with a file or a filehandle, this method returns the current autoflush setting for the underlying filehandle. If <code>EXPR</code> is present, and is non-zero, it will enable flushing after every write/print operation.</p>

<p>If <code>$z</code> is associated with a buffer, this method has no effect and always returns <code>undef</code>.</p>

<p><b>Note</b> that the special variable <code>$|</code> <b>cannot</b> be used to set or retrieve the autoflush setting.</p>

<h2 id="input_line_number">input_line_number</h2>

<pre><code>    $z-&gt;input_line_number()
    $z-&gt;input_line_number(EXPR)</code></pre>

<p>Returns the current uncompressed line number. If <code>EXPR</code> is present it has the effect of setting the line number. Note that setting the line number does not change the current position within the file/buffer being read.</p>

<p>The contents of <code>$/</code> are used to determine what constitutes a line terminator.</p>

<h2 id="fileno">fileno</h2>

<pre><code>    $z-&gt;fileno()
    fileno($z)</code></pre>

<p>If the <code>$z</code> object is associated with a file or a filehandle, <code>fileno</code> will return the underlying file descriptor. Once the <code>close</code> method is called <code>fileno</code> will return <code>undef</code>.</p>

<p>If the <code>$z</code> object is associated with a buffer, this method will return <code>undef</code>.</p>

<h2 id="close">close</h2>

<pre><code>    $z-&gt;close() ;
    close $z ;</code></pre>

<p>Closes the output file/buffer.</p>

<p>For most versions of Perl this method will be automatically invoked if the IO::Uncompress::UnLzip object is destroyed (either explicitly or by the variable with the reference to the object going out of scope). The exceptions are Perl versions 5.005 through 5.00504 and 5.8.0. In these cases, the <code>close</code> method will be called automatically, but not until global destruction of all live objects when the program is terminating.</p>

<p>Therefore, if you want your scripts to be able to run on all versions of Perl, you should call <code>close</code> explicitly and not rely on automatic closing.</p>

<p>Returns true on success, otherwise 0.</p>

<p>If the <code>AutoClose</code> option has been enabled when the IO::Uncompress::UnLzip object was created, and the object is associated with a file, the underlying file will also be closed.</p>

<h2 id="nextStream">nextStream</h2>

<p>Usage is</p>

<pre><code>    my $status = $z-&gt;nextStream();</code></pre>

<p>Skips to the next compressed data stream in the input file/buffer. If a new compressed data stream is found, the eof marker will be cleared and <code>$.</code> will be reset to 0.</p>

<p>Returns 1 if a new stream was found, 0 if none was found, and -1 if an error was encountered.</p>

<h2 id="trailingData">trailingData</h2>

<p>Usage is</p>

<pre><code>    my $data = $z-&gt;trailingData();</code></pre>

<p>Returns the data, if any, that is present immediately after the compressed data stream once uncompression is complete. It only makes sense to call this method once the end of the compressed data stream has been encountered.</p>

<p>This option can be used when there is useful information immediately following the compressed data stream, and you don&#39;t know the length of the compressed data stream.</p>

<p>If the input is a buffer, <code>trailingData</code> will return everything from the end of the compressed data stream to the end of the buffer.</p>

<p>If the input is a filehandle, <code>trailingData</code> will return the data that is left in the filehandle input buffer once the end of the compressed data stream has been reached. You can then use the filehandle to read the rest of the input file.</p>

<p>Don&#39;t bother using <code>trailingData</code> if the input is a filename.</p>

<p>If you know the length of the compressed data stream before you start uncompressing, you can avoid having to use <code>trailingData</code> by setting the <code>InputLength</code> option in the constructor.</p>

<h1 id="Importing">Importing</h1>

<p>No symbolic constants are required by IO::Uncompress::UnLzip at present.</p>

<dl>

<dt id=":all"><a id="all"></a>:all</dt>
<dd>

<p>Imports <code>unlzip</code> and <code>$UnLzipError</code>. Same as doing this</p>

<pre><code>    use IO::Uncompress::UnLzip qw(unlzip $UnLzipError) ;</code></pre>

</dd>
</dl>

<h1 id="EXAMPLES">EXAMPLES</h1>

<h1 id="SUPPORT">SUPPORT</h1>

<p>General feedback/questions/bug reports should be sent to <a href="https://github.com/pmqs/IO-Compress-Lzma/issues">https://github.com/pmqs/IO-Compress-Lzma/issues</a> (preferred) or <a href="https://rt.cpan.org/Public/Dist/Display.html?Name=IO-Compress-Lzma">https://rt.cpan.org/Public/Dist/Display.html?Name=IO-Compress-Lzma</a>.</p>

<h1 id="SEE-ALSO"><a id="SEE"></a>SEE ALSO</h1>

<p><a href="https://metacpan.org/pod/Compress::Zlib">Compress::Zlib</a>, <a href="https://metacpan.org/pod/IO::Compress::Gzip">IO::Compress::Gzip</a>, <a href="https://metacpan.org/pod/IO::Uncompress::Gunzip">IO::Uncompress::Gunzip</a>, <a href="https://metacpan.org/pod/IO::Compress::Deflate">IO::Compress::Deflate</a>, <a href="https://metacpan.org/pod/IO::Uncompress::Inflate">IO::Uncompress::Inflate</a>, <a href="https://metacpan.org/pod/IO::Compress::RawDeflate">IO::Compress::RawDeflate</a>, <a href="https://metacpan.org/pod/IO::Uncompress::RawInflate">IO::Uncompress::RawInflate</a>, <a href="https://metacpan.org/pod/IO::Compress::Bzip2">IO::Compress::Bzip2</a>, <a href="https://metacpan.org/pod/IO::Uncompress::Bunzip2">IO::Uncompress::Bunzip2</a>, <a href="./IO::Compress::Lzma.html">IO::Compress::Lzma</a>, <a href="./IO::Uncompress::UnLzma.html">IO::Uncompress::UnLzma</a>, <a href="./IO::Compress::Xz.html">IO::Compress::Xz</a>, <a href="./IO::Uncompress::UnXz.html">IO::Uncompress::UnXz</a>, <a href="./IO::Compress::Lzip.html">IO::Compress::Lzip</a>, <a href="./IO::Compress::Lzop.html">IO::Compress::Lzop</a>, <a href="./IO::Uncompress::UnLzop.html">IO::Uncompress::UnLzop</a>, <a href="./IO::Compress::Lzf.html">IO::Compress::Lzf</a>, <a href="./IO::Uncompress::UnLzf.html">IO::Uncompress::UnLzf</a>, <a href="./IO::Compress::Zstd.html">IO::Compress::Zstd</a>, <a href="./IO::Uncompress::UnZstd.html">IO::Uncompress::UnZstd</a>, <a href="https://metacpan.org/pod/IO::Uncompress::AnyInflate">IO::Uncompress::AnyInflate</a>, <a href="https://metacpan.org/pod/IO::Uncompress::AnyUncompress">IO::Uncompress::AnyUncompress</a></p>

<p><a href="https://metacpan.org/pod/IO::Compress::FAQ">IO::Compress::FAQ</a></p>

<p><a href="https://metacpan.org/pod/File::GlobMapper">File::GlobMapper</a>, <a href="./Archive::Zip.html">Archive::Zip</a>, <a href="https://metacpan.org/pod/Archive::Tar">Archive::Tar</a>, <a href="https://metacpan.org/pod/IO::Zlib">IO::Zlib</a></p>

<h1 id="AUTHOR">AUTHOR</h1>

<p>This module was written by Paul Marquess, <code>pmqs@cpan.org</code>.</p>

<h1 id="MODIFICATION-HISTORY"><a id="MODIFICATION"></a>MODIFICATION HISTORY</h1>

<p>See the Changes file.</p>

<h1 id="COPYRIGHT-AND-LICENSE"><a id="COPYRIGHT"></a>COPYRIGHT AND LICENSE</h1>

<p>Copyright (c) 2005-2023 Paul Marquess. All rights reserved.</p>

<p>This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.</p></div>

<div id="metacpan_install-instructions-dialog" class="modal fade">
  <div class="modal-dialog">
    <div class="modal-content">
      <div class="modal-header">
        <button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button>
        <h4 class="modal-title">Module Install Instructions</h4>
      </div>
      <div class="modal-body">
        <p>To install IO::Compress::Lzma, copy and paste the appropriate command in to your terminal.</p>
        <p><a href="https://metacpan.org/dist/App-cpanminus/view/bin/cpanm">cpanm</a></p>
        <pre><code>cpanm IO::Compress::Lzma</code></pre>
        <p><a href="https://metacpan.org/pod/CPAN">CPAN shell</a></p>
        <pre><code>perl -MCPAN -e shell
install IO::Compress::Lzma</code></pre>
        <p>For more information on module installation, please visit <a href="https://www.cpan.org/modules/INSTALL.html">the detailed CPAN module installation guide</a>.</p>
      </div>
      <div class="modal-footer">
        <a href="./IO::Uncompress::UnLzip.html#" data-dismiss="modal" class="btn">Close</a>
      </div>
    </div>
  </div>
</div>
          </main>
          <div class="content-pagination">
          </div>
        </div>
        <footer class="footer">
          <div class="footer-container">
            <div class="footer-social">
              <div class="footer-link footer-logo">
                <a href="https://metacpan.org/">
                  <img src="https://metacpan.org/static/images/metacpan-logo.svg" alt="MetaCPAN" />
                </a>
              </div>
              <a class="footer-social-link" href="https://github.com/metacpan">
                <i class="fab fa-github-square"></i>
              </a>
              <a class="footer-social-link" href="https://fosstodon.org/@metacpan">
                <i class="fab fa-mastodon"></i>
              </a>
            </div>
            <div class="footer-links">
              <div class="footer-link">
                  <a href="https://metacpan.org/about">About</a>
              </div>
              <div class="footer-link">
                  <a href="https://metacpan.org/about/sponsors">Sponsor</a>
              </div>
              <div class="footer-link">
                  <a href="https://grep.metacpan.org">grep::cpan</a>
              </div>
              <div class="footer-link">
                  <a href="https://metacpan.org/recent">Recent</a>
              </div>
              <div class="footer-link">
                  <a href="https://metacpan.org/about/faq">FAQ</a>
              </div>
              <div class="footer-link">
                  <a href="https://metacpan.org/tools">Tools</a>
              </div>
              <div class="footer-link">
                  <a href="https://fastapi.metacpan.org/">API</a>
              </div>
              <div class="footer-link">
                  <a href="https://www.perl.org/">Perl.org</a>
              </div>
            </div>
            <div class="footer-sponsors">
              <a class="footer-sponsor-link" target="_blank" href="https://www.bytemark.co.uk/" rel="noopener">
                <img class="footer-sponsor-bytemark" src="https://metacpan.org/static/images/sponsors/bytemark_logo.svg" alt="Bytemark logo">
              </a>
              <a class="footer-sponsor-link" target="_blank" href="https://www.liquidweb.com/" rel="noopener">
                <img class="footer-sponsor-liquidweb" src="https://metacpan.org/static/images/sponsors/liquidweb_logo.png" alt="liquidweb logo">
              </a>
              <a class="footer-sponsor-link" target="_blank" href="https://deriv.com/careers/" rel="noopener">
                <img class="footer-sponsor-deriv" src="https://metacpan.org/static/images/sponsors/deriv.svg" alt="Deriv logo">
              </a>
              <a class="footer-sponsor-link" target="_blank" href="https://geocode.xyz" rel="noopener">
                <img class="footer-sponsor-geocode" src="https://metacpan.org/static/images/sponsors/geocodelogo.svg" alt="Geocode logo">
              </a>
              <a class="footer-sponsor-link" target="_blank" href="https://www.fastly.com/" rel="noopener">
                <img class="footer-sponsor-fastly" src="https://metacpan.org/static/images/sponsors/fastly_logo.svg" alt="Fastly logo">
              </a>
              <a class="footer-sponsor-link" target="_blank" href="https://opencagedata.com" rel="noopener">
                <img class="footer-sponsor-opencage" src="https://metacpan.org/static/images/sponsors/open-cage.svg" alt="OpenCage logo">
              </a>
            </div>
          </div>
        </footer>
        <div class="modal fade" tabindex="-1" role="dialog" id="metacpan_keyboard-shortcuts">
          <div class="modal-dialog">
            <div class="modal-content">
              <div class="modal-header">
                <button type="button" class="close" data-dismiss="modal">&times;</button>
                <h4 class="modal-title">Keyboard Shortcuts</h4>
              </div>
              <div class="modal-body row">
<div class="col-md-6">
  <table class="table keyboard-shortcuts">
    <thead>
      <tr>
        <th></th>
        <th>Global</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td class="keys">
          <kbd>s</kbd>
        </td>
        <td>Focus search bar</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>?</kbd>
        </td>
        <td>Bring up this help dialog</td>
      </tr>
    </tbody>
  </table>

  <table class="table keyboard-shortcuts">
    <thead>
      <tr>
        <th></th>
        <th>GitHub</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>p</kbd>
        </td>
        <td>Go to pull requests</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>i</kbd>
        </td>
        <td>go to github issues (only if github is preferred repository)</td>
      </tr>
    </tbody>
  </table>
</div>

<div class="col-md-6">
  <table class="table keyboard-shortcuts">
    <thead>
      <tr>
        <th></th>
        <th>POD</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>a</kbd>
        </td>
        <td>Go to author</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>c</kbd>
        </td>
        <td>Go to changes</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>i</kbd>
        </td>
        <td>Go to issues</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>d</kbd>
        </td>
        <td>Go to dist</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>r</kbd>
        </td>
        <td>Go to repository/SCM</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>s</kbd>
        </td>
        <td>Go to source</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>b</kbd>
        </td>
        <td>Go to file browse</td>
      </tr>

    </tbody>
  </table>
</div>

<div class="col-md-12">
  <table class="table keyboard-shortcuts">
    <thead>
      <tr>
        <th></th>
        <th>Search terms</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><em>module:</em> (e.g. <a href="https://metacpan.org/search?q=module%3APlugin">module:Plugin</a>)</td>
      </tr>
      <tr>
        <td><em>distribution:</em> (e.g. <a href="https://metacpan.org/search?q=distribution%3ADancer+auth">distribution:Dancer auth</a>)</td>
      </tr>
      <tr>
        <td><em>author:</em> (e.g. <a href="https://metacpan.org/search?q=author%3ASONGMU+Redis">author:SONGMU Redis</a>)</td>
      </tr>
      <tr>
        <td><em>version:</em> (e.g. <a href="https://metacpan.org/search?q=version%3A1.00">version:1.00</a>)</td>
      </tr>
    </tbody>
  </table>
</div>
              </div>
              <div class="modal-footer"></div>
            </div>
          </div>
        </div>
    </body>
</html>
